/*
 * Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.dv8tion.jda.api.components;

import net.dv8tion.jda.api.components.actionrow.ActionRowChildComponentUnion;
import net.dv8tion.jda.api.components.container.ContainerChildComponentUnion;
import net.dv8tion.jda.api.components.section.SectionAccessoryComponentUnion;
import net.dv8tion.jda.api.components.section.SectionContentComponentUnion;

import javax.annotation.Nonnull;

/**
 * Base interface for {@link Component} union types.
 *
 * @see ActionRowChildComponentUnion
 * @see ContainerChildComponentUnion
 * @see SectionContentComponentUnion
 * @see SectionAccessoryComponentUnion
 * @see MessageTopLevelComponentUnion
 * @see ModalTopLevelComponentUnion
 */
public interface IComponentUnion extends Component {
    /**
     * Whether this component is an {@link UnknownComponent}.
     *
     * <p>Unknown components have restrictions, see {@link UnknownComponent} for details.
     *
     * <p>This is equivalent to {@code getType() == Type.UNKNOWN}.
     *
     * @return {@code true} if this is an unknown component, {@code false} if not.
     *
     * @see UnknownComponent
     */
    default boolean isUnknownComponent() {
        return this.getType() == Type.UNKNOWN;
    }

    @Nonnull
    @Override
    IComponentUnion withUniqueId(int uniqueId);
}
